/// <license>
/// Copyright (c) 2002-2008, DotNetNuke Corporation
/// All rights reserved
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
/// documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
/// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
/// to permit persons to whom the Software is furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in all copies or substantial portions 
/// of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 
/// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
/// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
/// CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
/// DEALINGS IN THE SOFTWARE.
/// </license>

#region Using Statements

using System;
using System.Collections.Generic;
using System.Text;
using System.Reflection;

#endregion

namespace DotNetNuke.ModuleToolkit.Common
{
    /// -----------------------------------------------------------------------------
    /// <summary>
    /// Helper class with utilities for accessing attributes
    /// </summary>
    /// <history>
    ///     [anurse]  12/22/2005  Created
    /// </history>
    /// -----------------------------------------------------------------------------
    public static class AttributeUtils
    {
        /// -----------------------------------------------------------------------------
        /// <summary>
        /// Retrieves the attribute specfied by <typeparamref name="TAttr"/> from the specified
        /// member.
        /// </summary>
        /// <typeparam name="TAttr">The attribute type to retrieve</typeparam>
        /// <param name="target">The member to search for the custom attribute</param>
        /// <param name="inherit">A boolean that indicates if the inheritance heirarchy should be traversed to find the attribute</param>
        /// <returns>The attribute requested, or null if it is not applied to the specified <paramref name="target"/></returns>
        /// <history>
        ///     [anurse]  12/22/2005  Created
        /// </history>
        /// -----------------------------------------------------------------------------
        public static TAttr GetAttribute<TAttr>(MemberInfo target, bool inherit) where TAttr : Attribute
        {
            object attribute = Attribute.GetCustomAttribute(target, typeof(TAttr), inherit);
            if ((attribute != null) && (attribute is TAttr))
                return (TAttr)attribute;
            else
                return null;
        }

        /// -----------------------------------------------------------------------------
        /// <summary>
        /// Retrieves all the attributes specfied by <typeparamref name="TAttr"/> from the specified
        /// member.
        /// </summary>
        /// <typeparam name="TAttr">The attribute type to retrieve</typeparam>
        /// <param name="target">The member to search for the custom attribute</param>
        /// <param name="inherit">A boolean that indicates if the inheritance heirarchy should be traversed to find the attribute</param>
        /// <returns>An array containing all the attributes of the specified type applied to the <paramref name="target"/></returns>
        /// <history>
        ///     [anurse]  12/22/2005  Created
        /// </history>
        /// -----------------------------------------------------------------------------
        public static TAttr[] GetAttributes<TAttr>(MemberInfo target, bool inherit) where TAttr : Attribute
        {
            return (TAttr[])Attribute.GetCustomAttributes(target, typeof(TAttr), inherit);
        }
    }
}
